{ "bundles": [ { "@type": "NXBundle", "artifactId": "nuxeo-platform-notification", "artifactVersion": "2023.19.6", "bundleGroup": { "@type": "NXBundleGroup", "bundleIds": [ "org.nuxeo.ecm.platform.notification", "org.nuxeo.ecm.platform.notification.web" ], "hierarchyPath": "/grp:org.nuxeo.ecm.platform/grp:org.nuxeo.ecm.platform.notification", "id": "grp:org.nuxeo.ecm.platform.notification", "name": "org.nuxeo.ecm.platform.notification", "parentIds": [ "grp:org.nuxeo.ecm.platform" ], "readmes": [], "version": "2023.19" }, "bundleId": "org.nuxeo.ecm.platform.notification", "components": [ { "@type": "NXComponent", "componentClass": "org.nuxeo.ecm.platform.ec.notification.service.NotificationService", "documentation": "\n This component provides a service for notifications.\n\n By registering with this extension point one can specify the possible\n notifications to which a user can subscribe, or to which a user is\n automatically subscribed.\n \n", "documentationHtml": "

\nThis component provides a service for notifications.\n

\nBy registering with this extension point one can specify the possible\nnotifications to which a user can subscribe, or to which a user is\nautomatically subscribed.\n

", "extensionPoints": [ { "@type": "NXExtensionPoint", "componentId": "org.nuxeo.ecm.platform.ec.notification.service.NotificationService", "descriptors": [ "org.nuxeo.ecm.platform.ec.notification.service.NotificationDescriptor", "org.nuxeo.ecm.platform.ec.notification.service.NotificationEventDescriptor" ], "documentation": "\n This extension point can be used to configure available notifications. A\n given notification has the form:\n \n \n \n \n \n\n\n The\n name\n\n is the identifier for this notification.\n\n The\n channel\n\n is always \"email\".\n\n The\n autoSubscribed\n\n flag can be true if this notification is aways taken into account, or\n false if you want to allow users to enable/disable this notification by\n themselves.\n\n The\n template\n\n refers to the body template, which can be configured through the\n \"templates\" extension point.\n\n The\n availableIn\n\n attribute specifies in which types of superspaces the notification is\n active, it can be a comma-separated lists of types, or \"*\" or \"all\" to\n make the notification active in any container.\n\n To disable an existing notification:\n \n \n\n", "documentationHtml": "

\nThis extension point can be used to configure available notifications. A\ngiven notification has the form:\n

    <notification autoSubscribed="false"\n        availableIn="Section, Workspace" channel="email"\n        name="Publication" template="publishContent">\n        <event name="sectionContentPublished"/>\n        <event name="myContentPublished"/>\n    </notification>\n

\nThe\nname\n

\nis the identifier for this notification.\n

\nThe\nchannel\n

\nis always "email".\n

\nThe\nautoSubscribed\n

\nflag can be true if this notification is aways taken into account, or\nfalse if you want to allow users to enable/disable this notification by\nthemselves.\n

\nThe\ntemplate\n

\nrefers to the body template, which can be configured through the\n"templates" extension point.\n

\nThe\navailableIn\n

\nattribute specifies in which types of superspaces the notification is\nactive, it can be a comma-separated lists of types, or "*" or "all" to\nmake the notification active in any container.\n

\nTo disable an existing notification:\n

    <notification enabled="false" name="Publication"/>\n

", "hierarchyPath": "/grp:org.nuxeo.ecm.platform/grp:org.nuxeo.ecm.platform.notification/org.nuxeo.ecm.platform.notification/org.nuxeo.ecm.platform.ec.notification.service.NotificationService/ExtensionPoints/org.nuxeo.ecm.platform.ec.notification.service.NotificationService--notifications", "id": "org.nuxeo.ecm.platform.ec.notification.service.NotificationService--notifications", "label": "notifications (org.nuxeo.ecm.platform.ec.notification.service.NotificationService)", "name": "notifications", "version": "2023.19.6" }, { "@type": "NXExtensionPoint", "componentId": "org.nuxeo.ecm.platform.ec.notification.service.NotificationService", "descriptors": [ "org.nuxeo.ecm.platform.ec.notification.service.TemplateDescriptor" ], "documentation": "\n This extension point can be used to define templates for notifications.\n\n By default inside the template files those expressions are available to use:\n\n ${docId} - the UID of the document that produced the notification\n\n ${author} - the user name of who or what produced the event\n\n ${principalAuthor} - the same as ${author}\n\n ${principalAuthor.firstName} - the first name of ${principalAuthor}\n if defined for the corresponding user\n\n ${principalAuthor.lastName} - the family name of ${principalAuthor}\n if defined for the corresponding user\n\n ${dateTime) - date and time when it happened - must be formatted according\n to the freemaker rules\n\n ${docUrl} - For now it displays the path to follow to get to the document\n that was the source of the event\n\n ${docTitle} - displays the title of the document that produced the\n notification\n\n ${newDocUrl} - this can display the path of the document modified/created\n inside the document that produced the notification. This newDoc is the\n child of the producer document.\n\n ${newDocTitle} - the same that ${newDocUrl}, but displays the title.\n\n ${newDocId} - the same that ${newDocUrl}, but displays the UID.\n\n If you need to add some more variables into your templates, just put the\n data you need to display in the notification in the eventInfo map of the\n JMS message that is sent to queue topic/NXPMessages.\n\n The same goes for subject but in this case there is no need to define a\n template. Just put the string that you need to have as subject and if it\n contains dynamic elements ${XXX}, they will be rendered just like it\n happens in the body.\n\n For example :\n\n When creating the message : mesage.getEventInfo().put(\"docSize\",\n sizeOfDocument);\n\n In your template file : The document has ${docSize}KB.\n\n @author Narcis Paslaru\n\n \n", "documentationHtml": "

\nThis extension point can be used to define templates for notifications.\n

\nBy default inside the template files those expressions are available to use:\n

\n${docId} - the UID of the document that produced the notification\n

\n${author} - the user name of who or what produced the event\n

\n${principalAuthor} - the same as ${author}\n

\n${principalAuthor.firstName} - the first name of ${principalAuthor}\nif defined for the corresponding user\n

\n${principalAuthor.lastName} - the family name of ${principalAuthor}\nif defined for the corresponding user\n

\n${dateTime) - date and time when it happened - must be formatted according\nto the freemaker rules\n

\n${docUrl} - For now it displays the path to follow to get to the document\nthat was the source of the event\n

\n${docTitle} - displays the title of the document that produced the\nnotification\n

\n${newDocUrl} - this can display the path of the document modified/created\ninside the document that produced the notification. This newDoc is the\nchild of the producer document.\n

\n${newDocTitle} - the same that ${newDocUrl}, but displays the title.\n

\n${newDocId} - the same that ${newDocUrl}, but displays the UID.\n

\nIf you need to add some more variables into your templates, just put the\ndata you need to display in the notification in the eventInfo map of the\nJMS message that is sent to queue topic/NXPMessages.\n

\nThe same goes for subject but in this case there is no need to define a\ntemplate. Just put the string that you need to have as subject and if it\ncontains dynamic elements ${XXX}, they will be rendered just like it\nhappens in the body.\n

\nFor example :\n

\nWhen creating the message : mesage.getEventInfo().put("docSize",\nsizeOfDocument);\n

\nIn your template file : The document has ${docSize}KB.\n

", "hierarchyPath": "/grp:org.nuxeo.ecm.platform/grp:org.nuxeo.ecm.platform.notification/org.nuxeo.ecm.platform.notification/org.nuxeo.ecm.platform.ec.notification.service.NotificationService/ExtensionPoints/org.nuxeo.ecm.platform.ec.notification.service.NotificationService--templates", "id": "org.nuxeo.ecm.platform.ec.notification.service.NotificationService--templates", "label": "templates (org.nuxeo.ecm.platform.ec.notification.service.NotificationService)", "name": "templates", "version": "2023.19.6" }, { "@type": "NXExtensionPoint", "componentId": "org.nuxeo.ecm.platform.ec.notification.service.NotificationService", "descriptors": [ "org.nuxeo.ecm.platform.ec.notification.service.GeneralSettingsDescriptor" ], "documentation": "\n This extension point can be used to define general settings. For now only\n server prefix E.g. : http://server:port/appName/\n\n \n", "documentationHtml": "

\nThis extension point can be used to define general settings. For now only\nserver prefix E.g. : http://server:port/appName/\n

", "hierarchyPath": "/grp:org.nuxeo.ecm.platform/grp:org.nuxeo.ecm.platform.notification/org.nuxeo.ecm.platform.notification/org.nuxeo.ecm.platform.ec.notification.service.NotificationService/ExtensionPoints/org.nuxeo.ecm.platform.ec.notification.service.NotificationService--generalSettings", "id": "org.nuxeo.ecm.platform.ec.notification.service.NotificationService--generalSettings", "label": "generalSettings (org.nuxeo.ecm.platform.ec.notification.service.NotificationService)", "name": "generalSettings", "version": "2023.19.6" }, { "@type": "NXExtensionPoint", "componentId": "org.nuxeo.ecm.platform.ec.notification.service.NotificationService", "descriptors": [ "org.nuxeo.ecm.platform.ec.notification.service.NotificationListenerHookDescriptor" ], "documentationHtml": "", "hierarchyPath": "/grp:org.nuxeo.ecm.platform/grp:org.nuxeo.ecm.platform.notification/org.nuxeo.ecm.platform.notification/org.nuxeo.ecm.platform.ec.notification.service.NotificationService/ExtensionPoints/org.nuxeo.ecm.platform.ec.notification.service.NotificationService--notificationListenerHook", "id": "org.nuxeo.ecm.platform.ec.notification.service.NotificationService--notificationListenerHook", "label": "notificationListenerHook (org.nuxeo.ecm.platform.ec.notification.service.NotificationService)", "name": "notificationListenerHook", "version": "2023.19.6" }, { "@type": "NXExtensionPoint", "componentId": "org.nuxeo.ecm.platform.ec.notification.service.NotificationService", "descriptors": [ "org.nuxeo.ecm.platform.ec.notification.service.NotificationListenerVetoDescriptor" ], "documentationHtml": "", "hierarchyPath": "/grp:org.nuxeo.ecm.platform/grp:org.nuxeo.ecm.platform.notification/org.nuxeo.ecm.platform.notification/org.nuxeo.ecm.platform.ec.notification.service.NotificationService/ExtensionPoints/org.nuxeo.ecm.platform.ec.notification.service.NotificationService--notificationListenerVeto", "id": "org.nuxeo.ecm.platform.ec.notification.service.NotificationService--notificationListenerVeto", "label": "notificationListenerVeto (org.nuxeo.ecm.platform.ec.notification.service.NotificationService)", "name": "notificationListenerVeto", "version": "2023.19.6" } ], "extensions": [], "hierarchyPath": "/grp:org.nuxeo.ecm.platform/grp:org.nuxeo.ecm.platform.notification/org.nuxeo.ecm.platform.notification/org.nuxeo.ecm.platform.ec.notification.service.NotificationService", "name": "org.nuxeo.ecm.platform.ec.notification.service.NotificationService", "requirements": [], "resolutionOrder": 426, "services": [ { "@type": "NXService", "componentId": "org.nuxeo.ecm.platform.ec.notification.service.NotificationService", "hierarchyPath": "/grp:org.nuxeo.ecm.platform/grp:org.nuxeo.ecm.platform.notification/org.nuxeo.ecm.platform.notification/org.nuxeo.ecm.platform.ec.notification.service.NotificationService/Services/org.nuxeo.ecm.platform.notification.api.NotificationManager", "id": "org.nuxeo.ecm.platform.notification.api.NotificationManager", "overriden": false, "version": "2023.19.6" } ], "startOrder": 846, "version": "2023.19.6", "xmlFileContent": "\n\n\n \n\n \n \n \n\n \n This component provides a service for notifications.\n\n By registering with this extension point one can specify the possible\n notifications to which a user can subscribe, or to which a user is\n automatically subscribed.\n \n \n \n This extension point can be used to configure available notifications. A\n given notification has the form:\n \n \n \n \n \n \n The\n name\n is the identifier for this notification.\n\n The\n channel\n is always \"email\".\n\n The\n autoSubscribed\n flag can be true if this notification is aways taken into account, or\n false if you want to allow users to enable/disable this notification by\n themselves.\n\n The\n template\n refers to the body template, which can be configured through the\n \"templates\" extension point.\n\n The\n availableIn\n attribute specifies in which types of superspaces the notification is\n active, it can be a comma-separated lists of types, or \"*\" or \"all\" to\n make the notification active in any container.\n\n To disable an existing notification:\n \n \n \n \n \n \n \n\n \n \n This extension point can be used to define templates for notifications.\n\n By default inside the template files those expressions are available to use:\n\n ${docId} - the UID of the document that produced the notification\n\n ${author} - the user name of who or what produced the event\n\n ${principalAuthor} - the same as ${author}\n\n ${principalAuthor.firstName} - the first name of ${principalAuthor}\n if defined for the corresponding user\n\n ${principalAuthor.lastName} - the family name of ${principalAuthor}\n if defined for the corresponding user\n\n ${dateTime) - date and time when it happened - must be formatted according\n to the freemaker rules\n\n ${docUrl} - For now it displays the path to follow to get to the document\n that was the source of the event\n\n ${docTitle} - displays the title of the document that produced the\n notification\n\n ${newDocUrl} - this can display the path of the document modified/created\n inside the document that produced the notification. This newDoc is the\n child of the producer document.\n\n ${newDocTitle} - the same that ${newDocUrl}, but displays the title.\n\n ${newDocId} - the same that ${newDocUrl}, but displays the UID.\n\n If you need to add some more variables into your templates, just put the\n data you need to display in the notification in the eventInfo map of the\n JMS message that is sent to queue topic/NXPMessages.\n\n The same goes for subject but in this case there is no need to define a\n template. Just put the string that you need to have as subject and if it\n contains dynamic elements ${XXX}, they will be rendered just like it\n happens in the body.\n\n For example :\n\n When creating the message : mesage.getEventInfo().put(\"docSize\",\n sizeOfDocument);\n\n In your template file : The document has ${docSize}KB.\n\n @author Narcis Paslaru\n\n \n \n \n\n \n \n This extension point can be used to define general settings. For now only\n server prefix E.g. : http://server:port/appName/\n\n \n \n \n\n \n \n \n\n \n \n \n\n\n", "xmlFileName": "/OSGI-INF/NotificationService.xml", "xmlPureComponent": false }, { "@type": "NXComponent", "documentationHtml": "", "extensionPoints": [], "extensions": [ { "@type": "NXContribution", "documentationHtml": "", "extensionPoint": "org.nuxeo.ecm.platform.ec.notification.service.NotificationService--notifications", "hierarchyPath": "/grp:org.nuxeo.ecm.platform/grp:org.nuxeo.ecm.platform.notification/org.nuxeo.ecm.platform.notification/org.nuxeo.ecm.platform.notification.service.NotificationContrib/Contributions/org.nuxeo.ecm.platform.notification.service.NotificationContrib--notifications", "id": "org.nuxeo.ecm.platform.notification.service.NotificationContrib--notifications", "registrationOrder": 4, "targetComponentName": { "rawName": "service:org.nuxeo.ecm.platform.ec.notification.service.NotificationService", "name": "org.nuxeo.ecm.platform.ec.notification.service.NotificationService", "type": "service" }, "version": "2023.19.6", "xml": "\n\n \n \n \n\n \n \n \n\n \n \n \n\n \n \n \n \n \n\n \n \n \n \n\n \n \n \n \n \n \n \n \n \n\n \n \n \n\n \n \n \n\n \n \n \n\n " }, { "@type": "NXContribution", "documentationHtml": "", "extensionPoint": "org.nuxeo.ecm.platform.ec.notification.service.NotificationService--templates", "hierarchyPath": "/grp:org.nuxeo.ecm.platform/grp:org.nuxeo.ecm.platform.notification/org.nuxeo.ecm.platform.notification/org.nuxeo.ecm.platform.notification.service.NotificationContrib/Contributions/org.nuxeo.ecm.platform.notification.service.NotificationContrib--templates", "id": "org.nuxeo.ecm.platform.notification.service.NotificationContrib--templates", "registrationOrder": 5, "targetComponentName": { "rawName": "service:org.nuxeo.ecm.platform.ec.notification.service.NotificationService", "name": "org.nuxeo.ecm.platform.ec.notification.service.NotificationService", "type": "service" }, "version": "2023.19.6", "xml": "\n\n